Update documentation (minor) #83
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
enryH
commented
Mar 3, 2025
enryH
commented
- remove old report from section
- format action yaml
- check sphinx warning (some headline warnings)
enryH
commented
May 5, 2025
| [latest releases](https://github.com/Multiomics-Analytics-Group/vuegen/releases/latest). | ||
| You will need to unzip the file and run `vuegen_gui` in the unpacked main folder. | ||
| Most dependencies are included into the bundle using PyInstaller. | ||
| Most dependencies are included into the bundle using [PyInstaller][pyinstaller]. |
Collaborator
Author
There was a problem hiding this comment.
Did you want to set a link?
Collaborator
There was a problem hiding this comment.
I just defined all links in the bottom, so we do not have them in the main md.
enryH
commented
May 5, 2025
README.md
Outdated
|
|
||
| More information regarding the app and builds can be found in the | ||
| [GUI README](https://github.com/Multiomics-Analytics-Group/vuegen/blob/main/gui/README.md). | ||
| [GUI README][gui-readme]. |
Collaborator
There was a problem hiding this comment.
Yes, I tested and works
enryH
commented
May 5, 2025
| ### Nextflow and nf-core | ||
|
|
||
| VueGen is also available as a [nf-core][nfcore] module, customised for compatibility with the [Nextflow][nextflow] environment. This module is designed to automate report generation from outputs produced by other modules, subworkflows, or pipelines. You can read the offical documentation for the nf-core module [here](nf-vuegen-nf-core). Also, the source code and detailed documentation are available in the [nf-VueGen repository][nf-vuegen]. | ||
| VueGen is also available as a [nf-core][nfcore] module, customised for compatibility with the [Nextflow][nextflow] environment. This module is designed to automate report generation from outputs produced by other modules, subworkflows, or pipelines. Asumming that you have `nextflow` and `nf-core` installed, you can use the following command to install the nf-core module: |
Collaborator
Author
There was a problem hiding this comment.
this is at least not rendered on readthedocs: https://vuegen--83.org.readthedocs.build/en/83/sections_readme/execution.html#running-vuegen-with-nextflow-and-nf-core
Collaborator
There was a problem hiding this comment.
I think this part is in the Installation section
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.